Skip to content

RcFileInstall RPC Command#1720

Merged
oneirocosm merged 2 commits intomainfrom
sylvie/rcfile-rpc
Jan 13, 2025
Merged

RcFileInstall RPC Command#1720
oneirocosm merged 2 commits intomainfrom
sylvie/rcfile-rpc

Conversation

@oneirocosm
Copy link
Contributor

Creates an RPC command for installing shell rcfiles instead of relying on a separate installation session.

This replaces the call that used a separate session with an rpc command.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Walkthrough

The pull request introduces a comprehensive refactoring of the remote configuration (RC) files installation process across multiple packages. The changes involve creating a new remote procedure call (RPC) mechanism for installing RC files, which replaces the previous direct SSH-based installation method.

The modification spans several key components, including the addition of a new RPC command remoteinstallrcfiles, implementation of corresponding methods in various packages like wshclient, wshremote, and wshrpctypes. The new approach introduces a more modular and standardized method for handling RC file installations across different system components.

The refactoring removes direct SSH-based file installation logic and replaces it with a more flexible RPC-driven approach, which allows for better error handling, timeout management, and potentially more consistent cross-platform behavior.

Finishing Touches

  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0174e7c and d134139.

📒 Files selected for processing (8)
  • cmd/wsh/cmd/wshcmd-rcfiles.go (2 hunks)
  • frontend/app/store/wshclientapi.ts (1 hunks)
  • pkg/remote/connutil.go (0 hunks)
  • pkg/shellexec/shellexec.go (1 hunks)
  • pkg/wshrpc/wshclient/wshclient.go (1 hunks)
  • pkg/wshrpc/wshremote/wshremote.go (1 hunks)
  • pkg/wshrpc/wshrpctypes.go (2 hunks)
  • pkg/wshutil/wshutil.go (2 hunks)
💤 Files with no reviewable changes (1)
  • pkg/remote/connutil.go
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (go)
  • GitHub Check: Build for TestDriver.ai
🔇 Additional comments (7)
cmd/wsh/cmd/wshcmd-rcfiles.go (1)

Line range hint 8-24: LGTM! Clean refactoring of rcfiles command.

The changes effectively centralize the path construction logic in the wshutil package while maintaining proper error handling.

🧰 Tools
🪛 golangci-lint (1.62.2)

22-22: printf: non-constant format string in call to github.com/wavetermdev/waveterm/cmd/wsh/cmd.WriteStderr

(govet)

pkg/wshrpc/wshremote/wshremote.go (1)

396-398: LGTM! Clean implementation of the RPC command.

The implementation follows the established pattern and maintains proper error handling.

frontend/app/store/wshclientapi.ts (1)

250-254: LGTM! Clean implementation of the RPC client method.

The implementation follows the established pattern and properly uses TypeScript's type system.

pkg/shellexec/shellexec.go (1)

308-311: LGTM! Error handling is preserved in the RPC migration.

The change successfully migrates from direct client RC file installation to using the new RPC command while maintaining proper error handling and logging.

pkg/wshrpc/wshclient/wshclient.go (1)

304-308: LGTM! Implementation follows established patterns.

The new RPC command is well-implemented, following the same patterns as other commands in the file:

  • Consistent error handling
  • Uses the common helper function
  • Proper documentation
pkg/wshrpc/wshrpctypes.go (2)

77-77: LGTM! Command constant follows conventions.

The new command constant follows the established naming pattern and value format used throughout the file.


185-185: LGTM! Interface method signature is consistent.

The new method in WshRpcInterface maintains consistency with other methods:

  • Takes context.Context
  • Returns error
  • Follows naming convention

Comment on lines +566 to +571
func InstallRcFiles() error {
home := wavebase.GetHomeDir()
waveDir := filepath.Join(home, wavebase.RemoteWaveHomeDirName)
winBinDir := filepath.Join(waveDir, wavebase.RemoteWshBinDirName)
return shellutil.InitRcFiles(waveDir, winBinDir)
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add error handling for home directory.

While the centralization of path construction logic is good, the function should handle the case where GetHomeDir() returns an empty string.

 func InstallRcFiles() error {
 	home := wavebase.GetHomeDir()
+	if home == "" {
+		return fmt.Errorf("home directory not found")
+	}
 	waveDir := filepath.Join(home, wavebase.RemoteWaveHomeDirName)
 	winBinDir := filepath.Join(waveDir, wavebase.RemoteWshBinDirName)
 	return shellutil.InitRcFiles(waveDir, winBinDir)
 }

Committable suggestion skipped: line range outside the PR's diff.

@oneirocosm oneirocosm merged commit 99e122d into main Jan 13, 2025
4 of 5 checks passed
@oneirocosm oneirocosm deleted the sylvie/rcfile-rpc branch January 13, 2025 00:31
xxyy2024 pushed a commit to xxyy2024/waveterm_aipy that referenced this pull request Jun 24, 2025
Creates an RPC command for installing shell rcfiles instead of relying
on a separate installation session.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant